<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PinCRT: Host machine queries</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">PinCRT
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Host machine queries</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0df31212789b90ca6b23a8c008b5c120"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a> { <br />
&#160;&#160;<b>OS_HOST_CPU_ARCH_TYPE_INVALID</b> = 0, 
<br />
&#160;&#160;<b>OS_HOST_CPU_ARCH_TYPE_IA32</b> = 1, 
<br />
&#160;&#160;<b>OS_HOST_CPU_ARCH_TYPE_INTEL64</b> = 2
<br />
 }</td></tr>
<tr class="separator:ga0df31212789b90ca6b23a8c008b5c120"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa5eea5ebfb007d1e0f818444680f6d2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#gaa5eea5ebfb007d1e0f818444680f6d2a">OS_GetHostName</a> (CHAR *buf, USIZE buflen)</td></tr>
<tr class="separator:gaa5eea5ebfb007d1e0f818444680f6d2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78c280fd813beaea5d9347a6d06836fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga78c280fd813beaea5d9347a6d06836fb">OS_GetHostCPUArch</a> (<a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a> *arch)</td></tr>
<tr class="separator:ga78c280fd813beaea5d9347a6d06836fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa37ee915c47839ad6003f3af61062065"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#gaa37ee915c47839ad6003f3af61062065">OS_CPUArchToString</a> (<a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a> arch)</td></tr>
<tr class="separator:gaa37ee915c47839ad6003f3af61062065"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63f243fccfef0a8b6f810c9bbe1af66c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga63f243fccfef0a8b6f810c9bbe1af66c">OS_GetKernelRelease</a> (CHAR *buf, USIZE bufsize)</td></tr>
<tr class="separator:ga63f243fccfef0a8b6f810c9bbe1af66c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a4d2b855c06ef3c0a12f5c34f858650"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga0a4d2b855c06ef3c0a12f5c34f858650">OS_GetOSName</a> (CHAR *buf, USIZE bufsize)</td></tr>
<tr class="separator:ga0a4d2b855c06ef3c0a12f5c34f858650"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2fdf5c40bd8366f41ccddc7a89943a15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga2fdf5c40bd8366f41ccddc7a89943a15">OS_GetOSVersion</a> (CHAR *buf, USIZE bufsize)</td></tr>
<tr class="separator:ga2fdf5c40bd8366f41ccddc7a89943a15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4eab96999f13590e408bd245a23c3f83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__HOST.html#ga4eab96999f13590e408bd245a23c3f83">OS_ReadProcessorFrequency</a> (UINT32 *freq)</td></tr>
<tr class="separator:ga4eab96999f13590e408bd245a23c3f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Contains API for host related queries </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga0df31212789b90ca6b23a8c008b5c120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0df31212789b90ca6b23a8c008b5c120">&#9670;&nbsp;</a></span>OS_HOST_CPU_ARCH_TYPE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>CPU Architecture </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa37ee915c47839ad6003f3af61062065"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa37ee915c47839ad6003f3af61062065">&#9670;&nbsp;</a></span>OS_CPUArchToString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* OS_CPUArchToString </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a>&#160;</td>
          <td class="paramname"><em>arch</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get a string representing a certain CPU arch.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">arch</td><td>The architecture to get a string for it</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">read-only</td><td>string representing the CPU arch</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="ga78c280fd813beaea5d9347a6d06836fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78c280fd813beaea5d9347a6d06836fb">&#9670;&nbsp;</a></span>OS_GetHostCPUArch()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_GetHostCPUArch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__OS__APIS__HOST.html#ga0df31212789b90ca6b23a8c008b5c120">OS_HOST_CPU_ARCH_TYPE</a> *&#160;</td>
          <td class="paramname"><em>arch</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Query CPU architecture.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">arch</td><td>The architecture of this system's CPU</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="gaa5eea5ebfb007d1e0f818444680f6d2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5eea5ebfb007d1e0f818444680f6d2a">&#9670;&nbsp;</a></span>OS_GetHostName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_GetHostName </td>
          <td>(</td>
          <td class="paramtype">CHAR *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">USIZE&#160;</td>
          <td class="paramname"><em>buflen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieves the host name of the current host - as known by this host</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the host name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">buflen</td><td>Size of buffer <b>buf</b> in bytes</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_BUFFER_TOO_SHORT</td><td>If the buffer <b>buf</b> is too short </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="ga63f243fccfef0a8b6f810c9bbe1af66c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63f243fccfef0a8b6f810c9bbe1af66c">&#9670;&nbsp;</a></span>OS_GetKernelRelease()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_GetKernelRelease </td>
          <td>(</td>
          <td class="paramtype">CHAR *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">USIZE&#160;</td>
          <td class="paramname"><em>bufsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get kernel release description string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the release string </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Size of buffer <b>buf</b> in bytes</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="ga0a4d2b855c06ef3c0a12f5c34f858650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a4d2b855c06ef3c0a12f5c34f858650">&#9670;&nbsp;</a></span>OS_GetOSName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_GetOSName </td>
          <td>(</td>
          <td class="paramtype">CHAR *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">USIZE&#160;</td>
          <td class="paramname"><em>bufsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the name of the operating system we're running on.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the OS name string </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Size of buffer <b>buf</b> in bytes</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="ga2fdf5c40bd8366f41ccddc7a89943a15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2fdf5c40bd8366f41ccddc7a89943a15">&#9670;&nbsp;</a></span>OS_GetOSVersion()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_GetOSVersion </td>
          <td>(</td>
          <td class="paramtype">CHAR *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">USIZE&#160;</td>
          <td class="paramname"><em>bufsize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the version of the operating system we're running on.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the OS version string </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Size of buffer <b>buf</b> in bytes</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
<a id="ga4eab96999f13590e408bd245a23c3f83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4eab96999f13590e408bd245a23c3f83">&#9670;&nbsp;</a></span>OS_ReadProcessorFrequency()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__DEF.html#ga8e6b2f5406a922a419991358caae6fc7">OS_RETURN_CODE</a> OS_ReadProcessorFrequency </td>
          <td>(</td>
          <td class="paramtype">UINT32 *&#160;</td>
          <td class="paramname"><em>freq</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get CPU processor frequency in MHz.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">freq</td><td>Frequency of the CPU</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">OS_RETURN_CODE_NO_ERROR</td><td>If the operation succeeded </td></tr>
    <tr><td class="paramname">OS_RETURN_CODE_QUERY_FAILED</td><td>If the operation failed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: macOS* <br  />
 <b>CPU:</b> All <br  />
</dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
